gnss23.h

Go to the documentation of this file.

/****************************************************************************
** Copyright (C) 2020 MikroElektronika d.o.o.
** Contact: https://www.mikroe.com/contact
**
** Permission is hereby granted, free of charge, to any person obtaining a copy
** of this software and associated documentation files (the "Software"), to deal
** in the Software without restriction, including without limitation the rights
** to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
** copies of the Software, and to permit persons to whom the Software is
** furnished to do so, subject to the following conditions:
** The above copyright notice and this permission notice shall be
** included in all copies or substantial portions of the Software.
**
** THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
** EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
** OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
** IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
** DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT
** OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
**  USE OR OTHER DEALINGS IN THE SOFTWARE.
****************************************************************************/

 
#ifndef GNSS23_H
#define GNSS23_H
 
#ifdef __cplusplus
extern "C"{
#endif

#ifdef PREINIT_SUPPORTED
#include "preinit.h"
#endif
 
#ifdef MikroCCoreVersion
    #if MikroCCoreVersion >= 1
        #include "delays.h"
    #endif
#endif
 
#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_uart.h"
#include "drv_i2c_master.h"




#define GNSS23_RSP_START                            "$"
#define GNSS23_RSP_DELIMITER                        ","
#define GNSS23_RSP_END                              "\r\n"
#define GNSS23_RSP_GGA                              "GGA"

#define GNSS23_DUMMY                                0xFF

#define GNSS23_GGA_ELEMENT_SIZE                     15
#define GNSS23_GGA_TIME                             1
#define GNSS23_GGA_LATITUDE                         2
#define GNSS23_GGA_LATITUDE_SIDE                    3
#define GNSS23_GGA_LONGITUDE                        4
#define GNSS23_GGA_LONGITUDE_SIDE                   5
#define GNSS23_GGA_QUALITY_INDICATOR                6
#define GNSS23_GGA_NUMBER_OF_SATELLITES             7
#define GNSS23_GGA_H_DILUTION_OF_POS                8
#define GNSS23_GGA_ALTITUDE                         9
#define GNSS23_GGA_ALTITUDE_UNIT                    10
#define GNSS23_GGA_GEOIDAL_SEPARATION               11
#define GNSS23_GGA_GEOIDAL_SEPARATION_UNIT          12
#define GNSS23_GGA_TIME_SINCE_LAST_DGPS             13
#define GNSS23_GGA_DGPS_REFERENCE_STATION_ID        14

#define GNSS23_I2C_SLAVE_CR_CMD                     0xAA51u
#define GNSS23_I2C_SLAVE_CW_CMD                     0xAA53u
#define GNSS23_I2C_SLAVE_CMD_LEN                    8
#define GNSS23_I2C_SLAVE_RX_LEN                     4
#define GNSS23_I2C_SLAVE_TX_LEN_REG_OFFSET          0x0008u
#define GNSS23_I2C_SLAVE_TX_BUF_REG_OFFSET          0x2000u
#define GNSS23_I2C_SLAVE_RX_LEN_REG_OFFSET          0x0004u
#define GNSS23_I2C_SLAVE_RX_BUF_REG_OFFSET          0x1000u
#define GNSS23_I2C_SLAVE_ADDRESS_CR_OR_CW           0x50
#define GNSS23_I2C_SLAVE_ADDRESS_R                  0x54
#define GNSS23_I2C_SLAVE_ADDRESS_W                  0x58
#define GNSS23_I2C_SLAVE_MAX_ERRORS                 10

#define GNSS23_TX_DRV_BUFFER_SIZE                   100
#define GNSS23_RX_DRV_BUFFER_SIZE                   800
 // gnss23_cmd



#define GNSS23_MAP_MIKROBUS( cfg, mikrobus ) \
    cfg.scl = MIKROBUS( mikrobus, MIKROBUS_SCL ); \
    cfg.sda = MIKROBUS( mikrobus, MIKROBUS_SDA ); \
    cfg.tx_pin = MIKROBUS( mikrobus, MIKROBUS_TX ); \
    cfg.rx_pin = MIKROBUS( mikrobus, MIKROBUS_RX ); \
    cfg.rst = MIKROBUS( mikrobus, MIKROBUS_RST ); \
    cfg.pps = MIKROBUS( mikrobus, MIKROBUS_INT );
 // gnss23_map // gnss23

typedef enum
{
    GNSS23_DRV_SEL_UART,     
    GNSS23_DRV_SEL_I2C       
 
} gnss23_drv_t;

struct gnss23_s;
typedef err_t ( *gnss23_master_io_t )( struct gnss23_s*, uint8_t*, uint16_t ); 

typedef struct gnss23_s
{
    // Output pins
    digital_out_t rst;              
 
    // Input pins
    digital_in_t pps;               
 
    // Modules
    uart_t uart;                    
    i2c_master_t i2c;               
 
    // Buffers
    uint8_t uart_rx_buffer[ GNSS23_RX_DRV_BUFFER_SIZE ];  
    uint8_t uart_tx_buffer[ GNSS23_TX_DRV_BUFFER_SIZE ];  
 
    uint8_t slave_address;          
    gnss23_drv_t drv_sel;           
 
    gnss23_master_io_t write_f;     
    gnss23_master_io_t read_f;      
 
} gnss23_t;

typedef struct
{
    // Communication gpio pins
    pin_name_t scl;                 
    pin_name_t sda;                 
    pin_name_t rx_pin;              
    pin_name_t tx_pin;              
 
    // Additional gpio pins
    pin_name_t rst;                 
    pin_name_t pps;                 
 
    uint32_t   i2c_speed;           
    uint8_t    i2c_address;         
 
    uint32_t         baud_rate;     
    bool             uart_blocking; 
    uart_data_bits_t data_bit;      
    uart_parity_t    parity_bit;    
    uart_stop_bits_t stop_bit;      
 
    gnss23_drv_t drv_sel;           
 
} gnss23_cfg_t;

typedef enum
{
    GNSS23_OK = 0,
    GNSS23_ERROR = -1
 
} gnss23_return_value_t;


void gnss23_cfg_setup ( gnss23_cfg_t *cfg );

void gnss23_drv_interface_sel ( gnss23_cfg_t *cfg, gnss23_drv_t drv_sel );

err_t gnss23_init ( gnss23_t *ctx, gnss23_cfg_t *cfg );

err_t gnss23_generic_write ( gnss23_t *ctx, uint8_t *data_in, uint16_t len );

err_t gnss23_generic_read ( gnss23_t *ctx, uint8_t *data_out, uint16_t len );

uint8_t gnss23_get_pps_pin ( gnss23_t *ctx );

void gnss23_set_rst_pin ( gnss23_t *ctx, uint8_t state );

void gnss23_reset_device ( gnss23_t *ctx );

err_t gnss23_parse_gga ( uint8_t *rsp_buf, uint8_t gga_element, uint8_t *element_data );
 
#ifdef __cplusplus
}
#endif
#endif // GNSS23_H
 // gnss23
 
// ------------------------------------------------------------------------ END